doc: update contributing guidelines wrt pre-commit/devtool #5204
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Point external contributors to use devtool instead of unmaintained pre-commit script to check code quality/style. Signed-off-by: Dakshin Devanand <[email protected]>
DakshinD
requested review from
xmarcalx,
kalyazin,
pb8o and
Manciukic
as code owners
Manciukic
reviewed
May 21, 2025
There was a problem hiding this comment.
Thanks for the contribution! The contribution guideline doc update looks good to me, but we should add a warning in the existing pre-commit script and mark it as deprecated.
We should also probably spin up a new issue to add the git-secrets check to the devctr integration tests.
Comment on lines
+74
to
+76
| > **Note:** The legacy rusty-hook pre-commit script has been deprecated and is | ||
| > unmaintained. Please use `devtool` for formatting, linting, and build checks | ||
| > during your development cycle. |
There was a problem hiding this comment.
can we add a warning in the original script as well so that we may remove it in the future?
Manciukic
added
Status: Awaiting author
Deprecates pre-commit hook and adds warning to the user, due to switch to devtool. Signed-off-by: Dakshin Devanand <[email protected]>
10 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Point external contributors to use devtool instead of unmaintained pre-commit script to check code
quality/style in
CONTRIBUTING.md. This is due to pre-commit script not being maintained anymore.Reason
Addresses issue #5201
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.PR Checklist
tools/devtool checkstyleto verify that the PR passes theautomated style checks.
how they are solving the problem in a clear and encompassing way.
in the PR.
CHANGELOG.md.Runbook for Firecracker API changes.
integration tests.
TODO.rust-vmm.